Skip to content

Update description of consistency metric#639

Merged
harisang merged 4 commits into
mainfrom
consistency_v2
Jul 6, 2026
Merged

Update description of consistency metric#639
harisang merged 4 commits into
mainfrom
consistency_v2

Conversation

@fhenneke

@fhenneke fhenneke commented Jul 3, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

The consistency metric has changed, as announced in this forum post. This PR updates the documentation accordingly.

Summary by CodeRabbit

  • Documentation
    • Updated the “consistency rewards” guidance (CIP-85) to apply a new consistency metric effective June 30, 2026.
    • Replaced order-count consistency with a metric based on bid quality (via normalized surplus) and settlement success rate, and clarified proportional budget allocation.
    • Documented settlement handling for late, missing, repeatedly unsettled wins, and scenarios where no orders are settled.
    • Updated the “solver’s strategy” section to reflect new incentives for broad participation with bids near the winning level, paired with reliable settlement.

@fhenneke @claude
docs: describe consistency metric v2
ec9083b 
Replace the order-count consistency metric description with the new
metric combining bid quality and settlement success rate, effective
June 30, 2026, and link the announcement forum post.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@fhenneke fhenneke requested a review from a team July 3, 2026 12:10
@fhenneke fhenneke requested a review from a team as a code owner July 3, 2026 12:10
@vercel

vercel Bot commented Jul 3, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jul 6, 2026 2:28pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e652287a-f6d7-434c-8d3c-450e73222ca7

📥 Commits

Reviewing files that changed from the base of the PR and between 5974925 and eb56388.

📒 Files selected for processing (1)
  • docs/cow-protocol/reference/core/auctions/rewards.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/cow-protocol/reference/core/auctions/rewards.md
📝 Walkthrough

Walkthrough

This PR updates the Consistency rewards documentation under CIP-85, replacing the order-count metric with a June 30, 2026 metric based on bid quality and settlement success rate, and revises the Solver’s strategy text accordingly.

Changes

Consistency Rewards Documentation

Layer / File(s) Summary
New consistency metric and strategy note
docs/cow-protocol/reference/core/auctions/rewards.md		 Replaces the order-count consistency metric with consistencyMetric based on bid quality (orderShare) and settlement success rate, and updates the Solver’s strategy paragraph to match the new incentive description.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • cowprotocol/docs#603: Also updates the Consistency rewards documentation and the metric description in docs/cow-protocol/reference/core/auctions/rewards.md.

Suggested reviewers: pretf00d, harisang

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: updating the documentation for the consistency metric.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch consistency_v2

Warning

Tools execution failed with the following error:

Failed to run tools: Stream initialization permanently failed: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

coderabbitai[bot]
coderabbitai Bot reviewed Jul 3, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/cow-protocol/reference/core/auctions/rewards.md`:
- Around line 80-84: The bid-quality formula in rewards.md leaves
`orderShare_i(o)` undefined when all bidders have zero surplus, so add the
intended zero-surplus fallback directly in this section. Update the
`orderShare_i(o)` definition to specify what happens when the denominator is
zero, and keep the explanation consistent with the surrounding `Bid quality`
description so readers can see how solver shares are assigned in that edge case.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bc7af1c7-e036-4358-8824-d47312de33b0

📥 Commits

Reviewing files that changed from the base of the PR and between d956c5a and ec9083b.

📒 Files selected for processing (1)
  • docs/cow-protocol/reference/core/auctions/rewards.md

Comment thread docs/cow-protocol/reference/core/auctions/rewards.md
harisang
harisang reviewed Jul 3, 2026
View reviewed changes
Comment thread docs/cow-protocol/reference/core/auctions/rewards.md Outdated
harisang
harisang reviewed Jul 3, 2026
View reviewed changes
Comment thread docs/cow-protocol/reference/core/auctions/rewards.md Outdated
harisang
harisang reviewed Jul 3, 2026
View reviewed changes
Comment thread docs/cow-protocol/reference/core/auctions/rewards.md Outdated
@fhenneke @claude
docs: address review comments on consistency metric
5974925 
- stress that only fair solutions count towards bid quality
- attribute the larger share on uncontested orders to competitive
  bids rather than the number of bidders
- add explicit formula for the proportional distribution of the
  consistency budget
- add "respectively" to the example order shares

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@fhenneke @claude
docs: define order shares when all bids have zero surplus
eb56388 
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@harisang harisang merged commit c793c55 into main Jul 6, 2026
5 checks passed
@harisang harisang deleted the consistency_v2 branch July 6, 2026 22:40
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@harisang harisang harisang approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fhenneke @harisang